home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmVaCreateSimplePopupMenu.z / XmVaCreateSimplePopupMenu
Encoding:
Text File  |  2002-10-03  |  13.7 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu((((3333UUUUXXXXNNNN))))IIIIXXXX SSSSyyyysssstttteeeemmmmXXXXmmmmVVVVVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu - A RowColumn widget convenience
  10.           creation function
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/RowColumn.h>
  14.           WWWWiiiiddddggggeeeetttt XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu(
  15.           WWWWiiiiddddggggeeeetttt ppppaaaarrrreeeennnntttt,
  16.           SSSSttttrrrriiiinnnngggg nnnnaaaammmmeeee,
  17.           XXXXttttCCCCaaaallllllllbbbbaaaacccckkkkPPPPrrrroooocccc ccccaaaallllllllbbbbaaaacccckkkk);
  18.  
  19.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  20.           This page documents Motif 2.1.
  21.  
  22.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.           XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu creates an instance of a RowColumn
  24.           widget of type XXXXmmmmMMMMEEEENNNNUUUU____PPPPOOOOPPPPUUUUPPPP and returns the associated
  25.           widget ID.  This routine uses the ANSI C variable-length
  26.           argument list (_v_a_r_a_r_g_s) calling convention.
  27.  
  28.           This routine creates a Popup menu pane and its button
  29.           children.  The name of each button is bbbbuuuuttttttttoooonnnn_____n, where _n is
  30.           an integer from 0 (zero) to the number of buttons in the
  31.           menu minus 1.  The name of each separator is sssseeeeppppaaaarrrraaaattttoooorrrr_____n,
  32.           where _n is an integer from 0 (zero) to the number of
  33.           separators in the menu minus 1.  The name of each title is
  34.           llllaaaabbbbeeeellll_____n, where _n is an integer from 0 (zero) to the number
  35.           of titles in the menu minus 1.  Buttons, separators, and
  36.           titles are named and created in the order in which they are
  37.           specified in the variable portion of the argument list.
  38.  
  39.           _p_a_r_e_n_t    Specifies the widget ID of the parent of the
  40.                     MenuShell
  41.  
  42.           _n_a_m_e      Specifies the name of the created widget
  43.  
  44.           _c_a_l_l_b_a_c_k  Specifies a callback procedure to be called when a
  45.                     button is activated or when its value changes.
  46.                     This callback function is added to each button
  47.                     after creation.  For a CascadeButtonGadget or a
  48.                     PushButtonGadget, the callback is added as the
  49.                     button's XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk, and it is called
  50.                     when the button is activated.  For a
  51.                     ToggleButtonGadget, the callback is added as the
  52.                     button's XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk, and it is called
  53.                     when the button's value changes.  The button
  54.                     number is returned in the _c_l_i_e_n_t__d_a_t_a field.
  55.  
  56.           The variable portion of the argument list consists of groups
  57.           of arguments.  The first argument in each group is a
  58.           constant or a string and determines which arguments follow
  59.           in that group.  The last argument in the list must be NULL.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu((((3333UUUUXXXXNNNN))))IIIIXXXX SSSSyyyysssstttteeeemmmmXXXXmmmmVVVVVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           The following list describes the possible first arguments in
  75.           each group of _v_a_r_a_r_g_s.
  76.  
  77.           XXXXmmmmVVVVaaaaCCCCAAAASSSSCCCCAAAADDDDEEEEBBBBUUUUTTTTTTTTOOOONNNN
  78.                     This is followed by two additional arguments. The
  79.                     set specifies one button in the PopupMenu and some
  80.                     of its resource values. The button created is a
  81.                     CascadeButtonGadget. Following are the additional
  82.                     two arguments, in order:
  83.  
  84.                     _l_a_b_e_l     The label string, of type XXXXmmmmSSSSttttrrrriiiinnnngggg
  85.  
  86.                     _m_n_e_m_o_n_i_c  The mnemonic, of type KKKKeeeeyyyySSSSyyyymmmm
  87.  
  88.           XXXXmmmmVVVVaaaaPPPPUUUUSSSSHHHHBBBBUUUUTTTTTTTTOOOONNNN
  89.                     This is followed by four additional arguments. The
  90.                     set specifies one button in the PopupMenu and some
  91.                     of its resource values. The button created is a
  92.                     PushButtonGadget. Following are the additional
  93.                     four arguments, in order:
  94.  
  95.                     _l_a_b_e_l     The label string, of type XXXXmmmmSSSSttttrrrriiiinnnngggg
  96.  
  97.                     _m_n_e_m_o_n_i_c  The mnemonic, of type KKKKeeeeyyyySSSSyyyymmmm
  98.  
  99.                     _a_c_c_e_l_e_r_a_t_o_r
  100.                               The accelerator, of type SSSSttttrrrriiiinnnngggg
  101.  
  102.                     _a_c_c_e_l_e_r_a_t_o_r__t_e_x_t
  103.                               The accelerator text, of type XXXXmmmmSSSSttttrrrriiiinnnngggg
  104.  
  105.           XXXXmmmmVVVVaaaaRRRRAAAADDDDIIIIOOOOBBBBUUUUTTTTTTTTOOOONNNN
  106.                     This is followed by four additional arguments. The
  107.                     set specifies one button in the PopupMenu and some
  108.                     of its resource values. The button created is a
  109.                     ToggleButtonGadget. Following are the additional
  110.                     four arguments, in order:
  111.  
  112.                     _l_a_b_e_l     The label string, of type XXXXmmmmSSSSttttrrrriiiinnnngggg
  113.  
  114.                     _m_n_e_m_o_n_i_c  The mnemonic, of type KKKKeeeeyyyySSSSyyyymmmm
  115.  
  116.                     _a_c_c_e_l_e_r_a_t_o_r
  117.                               The accelerator, of type SSSSttttrrrriiiinnnngggg
  118.  
  119.                     _a_c_c_e_l_e_r_a_t_o_r__t_e_x_t
  120.                               The accelerator text, of type XXXXmmmmSSSSttttrrrriiiinnnngggg
  121.  
  122.           XXXXmmmmVVVVaaaaCCCCHHHHEEEECCCCKKKKBBBBUUUUTTTTTTTTOOOONNNN
  123.                     This is followed by four additional arguments. The
  124.                     set specifies one button in the PopupMenu and some
  125.                     of its resource values. The button created is a
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu((((3333UUUUXXXXNNNN))))IIIIXXXX SSSSyyyysssstttteeeemmmmXXXXmmmmVVVVVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     ToggleButtonGadget. Following are the additional
  141.                     four arguments, in order:
  142.  
  143.                     _l_a_b_e_l     The label string, of type XXXXmmmmSSSSttttrrrriiiinnnngggg
  144.  
  145.                     _m_n_e_m_o_n_i_c  The mnemonic, of type KKKKeeeeyyyySSSSyyyymmmm
  146.  
  147.                     _a_c_c_e_l_e_r_a_t_o_r
  148.                               The accelerator, of type SSSSttttrrrriiiinnnngggg
  149.  
  150.                     _a_c_c_e_l_e_r_a_t_o_r__t_e_x_t
  151.                               The accelerator text, of type XXXXmmmmSSSSttttrrrriiiinnnngggg
  152.  
  153.           XXXXmmmmVVVVaaaaTTTTIIIITTTTLLLLEEEE This is followed by one additional argument. The
  154.                     pair specifies a title LabelGadget in the
  155.                     PopupMenu. Following is the additional argument:
  156.  
  157.                     _t_i_t_l_e     The title string, of type XXXXmmmmSSSSttttrrrriiiinnnngggg
  158.  
  159.           XXXXmmmmVVVVaaaaSSSSEEEEPPPPAAAARRRRAAAATTTTOOOORRRR
  160.                     This is followed by no additional arguments. It
  161.                     specifies one separator in the PopupMenu.
  162.  
  163.           XXXXmmmmVVVVaaaaDDDDOOOOUUUUBBBBLLLLEEEE____SSSSEEEEPPPPAAAARRRRAAAATTTTOOOORRRR
  164.                     This is followed by no additional arguments. It
  165.                     specifies one separator in the PopupMenu. The
  166.                     separator type is XXXXmmmmDDDDOOOOUUUUBBBBLLLLEEEE____LLLLIIIINNNNEEEE.
  167.  
  168.           _r_e_s_o_u_r_c_e__n_a_m_e
  169.                     This is followed by one additional argument, the
  170.                     value of the resource, of type _X_t_A_r_g_V_a_l. The pair
  171.                     specifies a resource and its value for the
  172.                     RowColumn widget.
  173.  
  174.           XXXXttttVVVVaaaaTTTTyyyyppppeeeeddddAAAArrrrgggg
  175.                     This is followed by four additional arguments. The
  176.                     set specifies a resource and its value for the
  177.                     RowColumn widget. A resource type conversion is
  178.                     performed if necessary. Following are the
  179.                     additional four arguments, in order:
  180.  
  181.                     _n_a_m_e      The resource name, of type SSSSttttrrrriiiinnnngggg
  182.  
  183.                     _t_y_p_e      The type of the resource value supplied,
  184.                               of type SSSSttttrrrriiiinnnngggg
  185.  
  186.                     _v_a_l_u_e     The resource value (or a pointer to the
  187.                               resource value, depending on the type
  188.                               and size of the value), of type _X_t_A_r_g_V_a_l
  189.  
  190.                     _s_i_z_e      The size of the resource value in bytes,
  191.                               of type _i_n_t
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu((((3333UUUUXXXXNNNN))))IIIIXXXX SSSSyyyysssstttteeeemmmmXXXXmmmmVVVVVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu((((3333XXXX))))
  203.  
  204.  
  205.  
  206.           XXXXttttVVVVaaaaNNNNeeeesssstttteeeeddddLLLLiiiisssstttt
  207.                     This is followed by one additional argument of
  208.                     type _X_t_V_a_r_A_r_g_s_L_i_s_t. This argument is a nested list
  209.                     of _v_a_r_a_r_g_s returned by XXXXttttVVVVaaaaCCCCrrrreeeeaaaatttteeeeAAAArrrrggggssssLLLLiiiisssstttt.
  210.  
  211.           For more information on variable-length argument lists, see
  212.           the X Toolkit Intrinsics documentation.
  213.  
  214.           A number of resources exist specifically for use with this
  215.           and other simple menu creation routines.  For a complete
  216.           definition of RowColumn and its associated resources, see
  217.           XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn(3).
  218.  
  219.      RRRREEEETTTTUUUURRRRNNNN
  220.           Returns the RowColumn widget ID.
  221.  
  222.      RRRREEEELLLLAAAATTTTEEEEDDDD
  223.           XXXXmmmmCCCCrrrreeeeaaaatttteeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu(3), XXXXmmmmCCCCrrrreeeeaaaatttteeeeRRRRoooowwwwCCCCoooolllluuuummmmnnnn(3),
  224.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeePPPPooooppppuuuuppppMMMMeeeennnnuuuu(3), and XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn(3).
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 10/3/02)
  262.  
  263.  
  264.  
  265.